You are here: Errors Reference > Documaker Standard Edition > Documaker Errors > Configuration > Defining the Output Message Files

Defining the Output Message Files

Several files are used by the message system. You identify the output files and their locations with these INI options:

< Data >
ERRFile = errfile.dat
LOGFile = logfile.dat
MSGFile = msgfile.dat
TranslationFile = translat.ini

The values for the LOGFile and ERRFile options are probably already set correctly if you are upgrading your system from an earlier version.

The values you specify for each option identify the file name for that option. You can also specify a directory path for each file. If you omit the path and include only the file name, the setting for the DataPath option is used as the default location for these files.

 

Option

Description

ERRFile

Identifies the file which contains the error messages.

LOGFile

Identifies the file which contains the log messages.

MSGFile

Identifies the message token file the system programs produce.

TranslationFile

Contains the message text. Normally defaults to TRANSLAT.INI. Use this option to specify the file name and location.

Unlike the other files, the TRANSLAT.INI file is static—it does not change during the batch process and is not considered a data file. This file’s location does not default to DataPath option as do the other files.

In the MVS environment, the DefLib option identifies the TRANSLAT.INI file’s default location if you do not specify a path in the TranslationFile option.

TRANSLAT.INI File

The TRANSLAT.INI file was designed to let you to translate output messages. Beginning with version 11.5, this file is being migrated to work through the Oracle national language support (NLS) interface. As a part of this migration, the TRANSLAT.INI file is now replaced with an Oracle message file (.MSG) which is compiled into a binary file (.MSB) and stored in the \Lang subdirectory of your executables directory. The English US translation is in the XLTUS.MSB file. As demand warrants, output messages will be translated into additional languages and compiled into additional .MSB files.

Message binary (.MSB) files are used on the Windows and UNIX platforms but the TRANSLAT.INI file is still used on mainframe platforms, such as on z/OS.

The expected format of NLS messages differs slightly from the format of messages within the TRANSLAT.INI file. To complete the interface, the TRANSLAT.MMP file is used to internally map the message parameters.

Initializing the Output Message Files

In a standard implementation, the GenTrn program is the first program run in the batch process. As the first program, it re-initializes the data files by first deleting the existing data files.

If your implementation does not use the GenTrn program, you ether have to set up the implementation to manually delete these files or you must include an additional INI option.

The ErrorFileOpenMode option lets you tell system programs to delete old message files before beginning its processing cycle. Here is an example of this option:

< Control >
ErrorFileOpenMode = Create

If you set this option to Create, the system deletes existing files and creates new ones for the processing run. If you leave this option blank or enter any other value, the system appends information onto existing files.

Turning Off Date Stamps

You can turn off date stamps in batch processing error and log files using these INI options:

< Control > 
ErrorFileDateStamp = No
LogFileDateStamp = No

Option

Description

ErrorFileDateStamp

Enter No to disable date stamps in error files. The default is Yes.

LogFileDateStamp

Enter No to disable the date stamp in log files. The default is Yes.

Entering No to turn off these options can be of use when regression testing.

Use this option to disable date stamps in the batch trace file:

< Debug_Switches >
PrintTimeStamp = No

Option

Description

PrintTimeStamp

Enter No to disable date stamps in the batch trace file. The default is Yes.

Controlling the Translation Process

By default, the GenTrn program deletes the old message file at the beginning of its execution and starts a new file with output information. All other programs, such as GenData, GenWIP, and so on, append information to the end of the message file created by the GenTrn program.

The default translation options are set so the log and error files are created after each system program executes. You can, however, set the ImmediateTranslate option to No to delay the translation process until all system programs finish processing—at the end of the batch process.

Here is an example:

< Control >
ImmediateTranslate = No

Once processing stops, you can then use the TRANSLAT utility to translate the messages. By delaying the translation process and only executing it once per batch cycle, you can reduce job throughput times.

If you set the ImmediateTranslate option to No, the system will not create the ERRFILE.DAT file.

DBLib Trace Messages

DBLib-related trace (or log) messages are written to the trace file. The name of this file defaults to trace but you can set it to another file name using the TraceFile option:

< Data >
TraceFile = xxxxx

We recommend you use the default name of trace.

Note   Before version 11.0, DBLib-related logging messages were written to the file indicated by this option:

< Data >
               DBLogFile = (file name)

The default was DBLOGFLE.DAT.

Keep in mind, all types of tracing, including DBLib tracing, slow performance. You should only activate DBLib tracing during development and testing or if requested by Documaker support personnel.

In the Rules Processor, the trace file for DBLIB log messages is the default logging file. You can activate DBLib tracing by specifying these INI options in the FSISYS.INI file:

< Debug_Switches >
Enable_Debug_Options	= Yes
DBLib			= Yes

In IDS, the default logging file is the DPRTRC.LOG file DBLIB log messages. You can enter the INI options in the DAP.INI file or the MRL-specific INI file.

Overriding Error Behavior

Use the ErrorCodeOverride control group to tell the system how you want it to handle specific errors. Your entries override how the system would normally process errors.

Here is how to set up the ErrorCodeOverride control group options:

< ErrorCodeOverride >
(ErrorNumber) = Warning
(ErrorNumber) = Critical
(ErrorNumber) = Error

Option

Description

ErrorNumber

For each error code you enter, select from these options to tell the system how you want it to handle the situation:

Warning

Error

Critical (stops all processing)

For example, the DM10836 code tells you the system cannot locate a specific chart object. Normally when this occurs, the system generates a warning and continues processing. If, however, you make the following entry, the system treats DM10836 as a critical error and stops processing the transaction.

< ErrorCodeOverride >
10836 = Critical